Skip to content

docs: add aggregated Javadoc generation via site-javadoc profile#988

Draft
kabir wants to merge 2 commits into
a2aproject:mainfrom
kabir:a2a-java-docs-javadoc
Draft

docs: add aggregated Javadoc generation via site-javadoc profile#988
kabir wants to merge 2 commits into
a2aproject:mainfrom
kabir:a2a-java-docs-javadoc

Conversation

@kabir

@kabir kabir commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Add a site-javadoc Maven profile that generates unified cross-module
Javadoc using maven-javadoc-plugin's aggregate goal. Cross-module @see
and {@link} references resolve as navigable HTML links.

  • Add site-javadoc profile to parent POM with aggregate goal
  • Move Javadoc menu entry from global menu to per-version menu in dev.yml
  • Add placeholder docs/public/dev/apidocs/index.html for unreleased versions
  • Update RELEASE.md with Javadoc generation steps for major/minor releases
  • Add Javadoc aggregation verification step to CI release profile workflow
  • add aggregated Javadoc for 1.0.0.Final and 1.1.0.Final

@kabir
kabir force-pushed the a2a-java-docs-javadoc branch from d3fc861 to 5930de8 Compare July 21, 2026 15:39
@kabir kabir changed the title docs: add aggregated Javadoc generation via site-javadoc profile docs: add aggregated Javadoc generation via site-javadoc profile Jul 21, 2026
@kabir
kabir marked this pull request as draft July 21, 2026 15:41

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces significant updates to the documentation, including new guides for Server setup, Client usage, Configuration, and Backward Compatibility. It also adds new extras modules (HTTP Clients, Storage, Replicated Queue Manager, OpenTelemetry) and updates the BOM structure. I have identified a few issues in the documentation examples: the TaskAuthorizationProvider implementation uses an incorrect map method (containsKey is needed instead of contains), and there is an inconsistency in the Task API usage (getStatus() and getId() should be used consistently).

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/content/dev/authorization.md Outdated
Comment thread docs/content/dev/extras/replicated-queue-manager.md
Comment thread docs/content/1.1.0.Final/extras/replicated-queue-manager.md
kabir and others added 2 commits July 22, 2026 16:27
Add versioned docs with a version dropdown, per-version sidebar menus,
and a version-scoped search filter. Content is organized into versioned
folders (1.0.0.Final, 1.1.0.Final, dev) with the default version
resolved from data files.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a `site-javadoc` Maven profile that generates unified cross-module
Javadoc using maven-javadoc-plugin's aggregate goal. Cross-module @see
and {@link} references resolve as navigable HTML links.

- Add site-javadoc profile to parent POM with aggregate goal
- Move Javadoc menu entry from global menu to per-version menu in dev.yml
- Add placeholder docs/public/dev/apidocs/index.html for unreleased versions
- Update RELEASE.md with Javadoc generation steps for major/minor releases
- Add Javadoc aggregation verification step to CI release profile workflow
@kabir
kabir force-pushed the a2a-java-docs-javadoc branch from c7287eb to c4a28fd Compare July 22, 2026 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant